-
-
Notifications
You must be signed in to change notification settings - Fork 5k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
[Docs] Convert rST to MyST (Markdown) #11145
Conversation
Signed-off-by: Rafael Vasquez <[email protected]>
👋 Hi! Thank you for contributing to the vLLM project. Once the PR is approved and ready to go, your PR reviewer(s) can run CI to test the changes comprehensively before merging. To run CI, PR reviewers can do one of these:
🚀 |
This pull request has merge conflicts that must be resolved before it can be |
Signed-off-by: Rafael Vasquez <[email protected]>
Signed-off-by: Rafael Vasquez <[email protected]>
Signed-off-by: Rafael Vasquez <[email protected]>
Signed-off-by: Rafael Vasquez <[email protected]>
Signed-off-by: Rafael Vasquez <[email protected]>
Signed-off-by: Rafael Vasquez <[email protected]>
Signed-off-by: Rafael Vasquez <[email protected]>
Signed-off-by: Rafael Vasquez <[email protected]>
Signed-off-by: Rafael Vasquez <[email protected]>
Signed-off-by: Rafael Vasquez <[email protected]>
Signed-off-by: Rafael Vasquez <[email protected]>
Signed-off-by: Rafael Vasquez <[email protected]>
Signed-off-by: Rafael Vasquez <[email protected]>
Signed-off-by: Rafael Vasquez <[email protected]>
Signed-off-by: Rafael Vasquez <[email protected]>
The links for code examples (e.g. https://vllm--11145.org.readthedocs.build/en/11145/getting_started/examples/api_client.html) are also broken. |
Signed-off-by: Rafael Vasquez <[email protected]>
Signed-off-by: Rafael Vasquez <[email protected]>
Nice catch @DarkLight1337, I addressed the output links in the examples. |
Hmm, I see that the Examples links are still missing the GitHub icon. Any way to fix that? |
Signed-off-by: Rafael Vasquez <[email protected]>
Signed-off-by: Rafael Vasquez <[email protected]>
Using markdown's automatic links |
The links in Compatibility Matrix are broken as well. |
Maybe make the warning in https://vllm--11145.org.readthedocs.build/en/11145/usage/performance.html#preemption a code block? |
Suggestion: Add inline code blocks for the last section of https://vllm--11145.org.readthedocs.build/en/11145/usage/usage_stats.html#opt-out-of-usage-stats-collection |
I have looked through the rest of the pages and they look fine. Nice work! |
This pull request has merge conflicts that must be resolved before it can be |
Signed-off-by: Rafael Vasquez <[email protected]>
Signed-off-by: Rafael Vasquez <[email protected]>
Signed-off-by: Rafael Vasquez <[email protected]>
Signed-off-by: Rafael Vasquez <[email protected]>
Looks like LoRA ref is broken. |
Signed-off-by: Rafael Vasquez <[email protected]>
Let's get this merged! |
Signed-off-by: Rafael Vasquez <[email protected]>
Signed-off-by: Rafael Vasquez <[email protected]>
This PR migrates the existing documentation from reStructuredText to MyST Markdown, a flavour of Markdown extended for use with Sphinx.
.md
template to gitignoremyst-parser
to3.0.1
.rst
docs into.md
, preserving content and formatting.rst
to.md
:ref: engine_args
->[engine-args](#engine-args)
Closes #10427